Magic Words Core v1.3
by Amaikokonut || https://naturingnurturing.blogspot.com

May be found at Naturing :: Nurturing (https://naturingnurturing.blogspot.com) and/or Naturing :: Nurturing :: Static (https://naturingnurturing.songua.com) and/or a friendly community archive near you! (It's also possible this actually made it out in time for CCSF '23, in which case, happy CCSF!)

If you're going to rehost or redistribute this agent, please leave this readme intact.

If you have any comments, questions, bug reports, or just want to chat, email amaikokonut@songua.com


:: Installation ::

BE SURE to remove any previous versions of Magic Words Core from your bootstrap so they don't override this one!

This zip file contains both an agent as well as the raw cosfiles and assets.

If you rarely use Magic Words, you can move the .agents file to your My Agents folder and inject it on a per-world basis.

If you use Magic Words a lot, extract the contents of this zipfile into your game folder so that the Bootstrap folder merges with your main Bootstrap and the Images folder merges with your main Images folder. This is the recommended installation.

In general, I recommend keeping all your Magic Words cosfiles in their own bootstrap folder, such as \021 Magic Words, and all CAOS functions in a folder that preceeds that folder alphabetically, such as \012 CAOS Functions. This will make it easier to find and remove/replace the files as needed, as well as ensure the CAOS Functions are injected before other mods that might require them to function.


:: About ::

This is an agent that you inject in parts-- the core agent allows for speech-bubble activated scripts while various modules define the activation words and scripts themselves.

Once injected, typing "help" into the speech bubble (as though you were talking to a creature) will bring up a window listing all the commands available to you. If you haven't injected any modules, it won't show much of anything, but it will update itself as you inject more modules. This way you won't have to memorize every single command when you have fifty modules injected.

Writing your own magic words commands is possible and encouraged! You can find a template and a breakdown here: https://naturingnurturing.blogspot.com/2011/11/magic-words-template.html

Note that since that template was published, two new features have been added to enrich the possibilities of Magic Words Commands:

- In 1.2 it became possible to NOT have the text in the speech bubble force-converted into lower case before it is passed to your agent by prefacing the command name with "-" instead of "_"

- In 1.3, if the user also has Speech Bubble Upgrades 1.2 installed, the agent that is actually calling the magic words command will be passed in to the magic words script as _p2_. This is to allow other agents that use speech bubbles to use magic words commands that result in object movement and have those objects moved to the agent that called them instead of always to the hand. Note that to take advantage of this fully, magic words commands themselves will need to be updated to utilize the _p2_ parameter in their checks before moving the objects. Does that make any sense? I hope that makes sense. Feel free to ask me for a more thorough explanation if you're confused.

Additionally, 1.3 added the ability for other agents to call Magic Words directly on another agent's behalf. The syntax for this is:

mesg wrt+ game "amk_magic_words_core_agent" 1000 [phrase] [agent] 0

for example: mesg wrt+ game "amk_magic_words_core_agent" 1000 "import 1" norn 0 -- imports one creature next to the currently selected creature (assuming you have magic words import/export installed)

Happy norning!

:: Changelog ::

Oct 31 2023: Added larger help window option and direct call script
August 10 2023: Added support for magic words commands to obtain information about what agent is calling the magic words.
May 2 2021: Added support for magic words that do NOT want their case force-converted to lower.
10-14-2017: Added a fix to prevent the core from getting injected more than once.
10-13-2017: New Readme Added 
11-05-2011: Initial Release